HtmlSettings

Print settings available when printing HTML content on the PDF printer.

Since

7.13

Functions

Link copied to clipboard
abstract fun apply()
Applies the configured print settings.
Link copied to clipboard
Disables printing background graphics.
Link copied to clipboard
Disables printing headers and footers.
Link copied to clipboard
Disables printing only the selected content.
Link copied to clipboard
Enables printing background graphics.
Link copied to clipboard
Enables printing headers and footers.
Link copied to clipboard
Enables printing only the selected content.
Link copied to clipboard
abstract fun footer(): String
Returns a value used for the footer.
abstract fun footer(html: String): T
Configures HTML to be displayed in the footer.
Link copied to clipboard
abstract fun header(): String
Returns a value used for the header.
abstract fun header(html: String): T
Configures HTML to be displayed in the header.
Link copied to clipboard
Returns true if printing background graphics is enabled.
Link copied to clipboard
Returns true if printing headers and footer is enabled.
Link copied to clipboard
Returns true if printing only the selected content is enabled.
Link copied to clipboard
abstract fun orientation(): Orientation
Returns the page orientation.
abstract fun orientation(orientation: Orientation): T
Configures the page orientation.
Link copied to clipboard
abstract fun pageMargins(): PageMargins
Returns the page margins.
abstract fun pageMargins(pageMargins: PageMargins): T
Configures the page margins for printing.
Link copied to clipboard
abstract fun pageRanges(): Set<PageRange>
Returns an immutable set containing the page ranges to print.
abstract fun pageRanges(pageRanges: Array<PageRange>): T
abstract fun pageRanges(pageRanges: Set<PageRange>): T
Configures the page ranges to print.
Link copied to clipboard
abstract fun pagesPerSheet(): PagesPerSheet
Returns the number of pages per sheet.
abstract fun pagesPerSheet(pagesPerSheet: PagesPerSheet): T
Configures the number of pages per sheet.
Link copied to clipboard
abstract fun paperSize(): PaperSize
Returns the paper size used by the printer.
abstract fun paperSize(paperSize: PaperSize): T
Configures the paper size for printing.
Link copied to clipboard
abstract fun pdfFilePath(): Optional<Path>
Returns an Optional that contains the absolute destination PDF file path, or an empty Optional if there is not path configured.
abstract fun pdfFilePath(pdfFilePath: Path): T
Configures the path to the destination PDF file to print to.
Link copied to clipboard
abstract fun scaling(): Scaling
Returns the scaling used by the printer.
abstract fun scaling(scaling: Scaling): T
Configures the scaling for printing.